InfoMagic Standards 1994 January/InfoMagic Standards - January 1994.iso/iso/9660/rockrdge/rrg.11/api.cmd.nr

Text File | 1992-08-19 | 8KB | 492 lines

.sp
.H 2 "Definition of CD-ROM Specific User Commands"
.sp
This sections provides manual pages which describe CD-ROM user commands
for users in detail.
The user commands are:
.sp
.TS
center;
l l.
Name    Description
\_    \_

cdsuf    Retrieve a System Use Field

cddevsuppl    Set and get major/minor numbers of a device file
.TE
.sp
.bp
.sp
.H 3 "cdsuf command"
.sp
.in 0
.ft 3
NAME
.ft 1
.in 2
.br
.ft 3
cdsuf
.ft 1
- read the System Use Fields from a System Use Area
.sp
.in 0
.ft 3
SYNOPSIS
.ft 1
.in 2
.ft 3
.br
.ft 3
cdsuf
.ft 1
[-s number]  [-b]  file
.sp
.in 0
.ft 3
DESCRIPTION
.ft 1
.in 2
.br
This command is used to access the System Use Fields of the System Use
Area associated with a File Section of a file or directory and to list
its contents on standard output, following any Continuation Fields that
may be present.
.sp
.in 0
.ft 3
OPTIONS
.ft 1
.in 2
.br
The following options are available:
.VL 15 5
.LI "\f3-s number\f1"
This option specifies the File Section for which the System Use Area shall
be read.
The numbering starts with one.
If this option is omitted the last File Section of that file is assumed.
.LI "\f3-b\f1"
With this option all of the System Use Fields of the System Use Area are
copied from the CD-ROM to standard output in binary format.
.LE
.sp
.in 0
.ft 3
OPERAND
.ft 1
.in 2
.br
The operand
.I file\^
is the name of any file or directory within the CD-ROM file hierarchy.
.sp
.in 0
.ft 3
STDIN
.ft 1
.in 2
.br
Not Used.
.sp
.in 0
.ft 3
INPUT FILES
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
ENVIRONMENT VARIABLES
.ft 1
.in 2
.br
LC_TIME determines the format and contents of date and time strings.
If LC_TIME is not set in the environment or is set to the empty string,
the value of LANG will be used as a default.
If LANG is not set or set to the empty string, the corresponding
value from the implementation-specific default locale will be used.
If LC_TIME or LANG contain an invalid setting, the utility will behave
as if none of the variables had been defined.
.sp
.in 0
.ft 3
STDOUT
.ft 1
.in 2
.br
The output is formatted in the form of a table which contains an entry
for each System Use Field in the System Use Area as recorded on the CD-ROM.
Each entry of the table shall have the fields
.I Signature,\^
.I Length,\^
.I Version,\^
and
.I Data\^
as specified in the System Use Sharing Protocol.
Whether to break up the
.I Data\^
field into smaller fields according to the protocol which defined the
.I Signature\^
field is left up to the implementation.
.sp
If the
.ft 3
-b
.ft 1
option is applied, the contents of the full System Use Area
are written to standard output in binary format as it is recorded on the CD-ROM.
.sp
.in 0
.ft 3
STDERR
.ft 1
.in 2
.br
Used only for diagnostic messages.
.sp
.in 0
.ft 3
OUTPUT FILES
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
EXIT STATUS
.ft 1
.in 2
.br
The following exit values are returned:
.sp
.VL 15 5
.LI "0"
successful completion
.LI "1"
file not found or file is not a file or directory within a CD-ROM file
hierarchy or access denied
.LI "2"
File Section indicated by -s does not exist
.LI "3"
File Section indicated by -s has no System Use Area
.LE
.sp
.in 0
.ft 3
CONSEQUENCES OF ERRORS
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
APPLICATION USAGE
.ft 1
.in 2
.br
The user must have read permission for
.I file\^
to execute the command successfully.
.sp
.in 0
.ft 3
EXAMPLES
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
FUTURE DIRECTIONS
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
SEE ALSO
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
CHANGE HISTORY
.ft 1
.in 2
.br
None.
.sp
.in 0
.bp
.sp
.H 3 "cddevsuppl command"
.sp
.in 0
.ft 3
NAME
.ft 1
.in 2
.br
.ft 3
cddevsuppl
.ft 1
- set and get the major and minor numbers of a device file
.sp
.in 0
.ft 3
SYNOPSIS
.ft 1
.in 2
.br
.ft 3
cddevsuppl
.ft 1
[-m mapfile | -u unmapfile]  [-c]
.sp
.in 0
.ft 3
DESCRIPTION
.ft 1
.in 2
.br
This command is used to map and unmap the major and minor numbers of a device
file on a mounted CD-ROM.
.sp
If
.I cddevsuppl\^
is executed without the
.ft 3
-m
.ft 1
or
.ft 3
-u
.ft 1
option, it lists the current device file mappings
on the system.
.sp
The \f3-m mapfile\f1 and \f3-u unmapfile\f1 options are mutually exclusive.
.sp
.in 0
.ft 3
OPTIONS
.ft 1
.in 2
.br
The following options are available:
.VL 20 5
.LI "\f3-m mapfile\f1"
This option will map the major and minor numbers for device files.
The mappings are specified in
.I mapfile.\^
This file has one entry for each device file mapping in the format:
.sp
.TS
center;
c c c.
device_file_path    new_major    new_minor
.TE
.sp
The fields are separated by white space.
The entries are separated by newlines.
Anything beyond the third field shall be treated as a comment.
.sp
The maximum number of mappings is defined in the header file
.I <sys/cdrom.h>.\^
A previous device file mapping for a specific device file is overridden
if that device file that is mapped again.
.sp
.LI "\f3-u unmapfile\f1"
This option will unmap the major and minor numbers for device files.
The mappings are specified in
.I unmapfile.\^
This file has one entry for each device file mapping in the format:
.sp
.TS
center;
c.
device_file_path
.TE
.sp
The entries are separated by newlines.
Anything beyond the first field shall be treated as a comment.
.sp
.LI "\f3-c\f1"
This option is only useful when used in combination with the
\f3-m mapfile\f1 or \f3-u unmapfile\f1
options.
The
.ft 3
-c
.ft 1
option will cause
.I cddevsuppl\^
to continue processing the device file mappings if an error is returned
for a specific device file mapping.
An error message for that specific device file will be printed to
standard error.
The default action is to stop processing when an error has occurred.
.LE
.sp
.in 0
.ft 3
OPERAND
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
STDIN
.ft 1
.in 2
.br
Not used.
.sp
.in 0
.ft 3
INPUT FILES
.ft 1
.in 2
.br
The input files are text files.
.sp
.in 0
.ft 3
ENVIRONMENT VARIABLES
.ft 1
.in 2
.br
No environment variables affect the execution of
.I cddevsuppl.\^
Note that LC_CTYPE will not be used in filename conversion.
.sp
.in 0
.ft 3
STDOUT
.ft 1
.in 2
.br
If no options are used the current device file mappings are listed on
standard output.
In the case of \f3-m mapfile\f1, the new setting is listed
if the mapping was completed successfully.
In the case of \f3-u unmapfile\f1, the device file and
the major/minor numbers as recorded on the CD-ROM are listed if
the unmapping was completed successfully.
.sp
.in 0
.ft 3
STDERR
.ft 1
.in 2
.br
Used only for diagnostic messages.
.sp
.in 0
.ft 3
OUTPUT FILES
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
EXIT STATUS
.ft 1
.in 2
.br
The following exit values are returned:
.sp
.VL 15 5
.LI "0"
successful completion
.LI "1"
file not found or file is not a file or directory within a CD-ROM file
hierarchy or access denied
.LI "2"
not user with appropriate privileges
.LI "3"
too many mappings
.LI "4"
parameter error or bad format in a mapping file
.LI "5"
file is not a device file
.LI "6"
file not previously mapped
.LE
.sp
.in 0
.ft 3
CONSEQUENCES OF ERRORS
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
APPLICATION USAGE
.ft 1
.in 2
.br
Only a user with appropriate privileges may change administrative CD-ROM
features successfully.
To read the current device file mappings, the user must have read
permission on the device file.
.sp
Mappings should be established before affected device files are used.
If the command is applied for device file mappings when device files
have already been opened, the
effect of this command on these files is undefined.
.sp
The device file mappings for a mounted CD-ROM are eliminated when the
CD-ROM is unmounted.
.sp
.in 0
.ft 3
EXAMPLES
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
FUTURE DIRECTIONS
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
SEE ALSO
.ft 1
.in 2
.br
None.
.sp
.in 0
.ft 3
CHANGE HISTORY
.ft 1
.in 2
.br
None.
.sp
.in 0
.bp